Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove Cli #1444

Merged
merged 18 commits into from
Jul 17, 2019
Merged

Remove Cli #1444

merged 18 commits into from
Jul 17, 2019

Conversation

shanaxel42
Copy link
Collaborator

@shanaxel42 shanaxel42 commented Jul 11, 2019

Remove CLI code and pipeline component class.
Rename package names so that the algorithms can be used in the same way, ex.

from starifish import Filter
wth = Filter.WhiteTopHat()

Changed AlgorithmBase to be the MetaClass for logging.

Everything api-wise should work the same. Everything cli-wise should be removed.

One exception was the starfish validate command. Also I kept the ascii art cause that's essential

@codecov-io
Copy link

codecov-io commented Jul 15, 2019

Codecov Report

Merging #1444 into master will decrease coverage by 2.35%.
The diff coverage is 86.44%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1444      +/-   ##
==========================================
- Coverage   89.78%   87.42%   -2.36%     
==========================================
  Files         161      139      -22     
  Lines        5972     5178     -794     
==========================================
- Hits         5362     4527     -835     
- Misses        610      651      +41
Impacted Files Coverage Δ
.../image/_registration/LearnTransform/translation.py 96.15% <ø> (ø)
starfish/core/image/Filter/util.py 83.33% <ø> (ø)
starfish/core/image/Filter/linear_unmixing.py 73.07% <ø> (ø)
...ish/core/image/Filter/zero_by_channel_magnitude.py 100% <ø> (ø)
starfish/core/image/Filter/clip_value_to_zero.py 63.63% <ø> (ø)
starfish/core/image/Filter/bandpass.py 96.55% <ø> (ø)
...spots/DetectSpots/trackpy_local_max_peak_finder.py 92.85% <ø> (ø)
starfish/core/image/Filter/call_bases.py 100% <ø> (ø)
starfish/core/image/Filter/white_tophat.py 100% <ø> (ø)
starfish/core/image/Filter/mean_high_pass.py 100% <ø> (ø)
... and 71 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update dc502e7...2eb913b. Read the comment docs.

@shanaxel42 shanaxel42 changed the title [WIP] Remove Cli Remove Cli Jul 15, 2019
Copy link
Collaborator

@ttung ttung left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Depending on if there are any commands left in starfish CLI (e.g., starfish validate), you may be able to dump the custom click package as well. I suspect there is value to keeping starfish validate though.

@@ -57,9 +57,6 @@ jobs:
- name: 3D smFISH data processing example
if: type = push and branch =~ /^(master|merge)/
script: make install-dev 3d_smFISH.py
- name: iss_cli.sh data processing example
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can plausibly remove the Makefile rules for running .sh data processing examples.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ping

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

removed!

docs/source/index.rst Outdated Show resolved Hide resolved
from starfish.core.image.Filter.reduce import Reduce


methods: Mapping[str, Type] = {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you just do a dir(Filter) to get this?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ping

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried this and it doesn't quite give me what I need. ['Bandpass', 'Clip', 'ClipPercentileToZero', 'ClipValueToZero', 'DeconvolvePSF', 'ElementWiseMultiply', 'GaussianHighPass', 'GaussianLowPass', 'Laplace', 'LinearUnmixing', 'MatchHistograms', 'MaxProject', 'MeanHighPass', 'Reduce', 'WhiteTophat', 'ZeroByChannelMagnitude', '__builtins__', '__cached__', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__path__', '__spec__', '_base', 'bandpass', 'clip', 'clip_percentile_to_zero', 'clip_value_to_zero', 'element_wise_mult', 'gaussian_high_pass', 'gaussian_low_pass', 'laplace', 'linear_unmixing', 'match_histograms', 'max_proj', 'mean_high_pass', 'reduce', 'richardson_lucy_deconvolution', 'util', 'white_tophat', 'zero_by_channel_magnitude'] but I think the refactor to make another clever auto import method will work when I do that!

@@ -75,20 +75,6 @@ origin. At this point, it's trivial to create a cell x gene matrix.

tutorials/exec_feature_identification_and_annotation.rst

Putting Together a Pipeline Recipe and Running it
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we dropping the recipe runner?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I took out all the recipe stuff :/ should leave the runner in?


::

$ starfish validate experiment tmp/experiment.json
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to preserve some documentation about starfish validate?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I still have just the validate documentation in but I took out the builder bit

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is plausible that we want to retain the example about validating an existing experiment.

Copy link
Collaborator

@ttung ttung left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pls see comments.

@@ -57,9 +57,6 @@ jobs:
- name: 3D smFISH data processing example
if: type = push and branch =~ /^(master|merge)/
script: make install-dev 3d_smFISH.py
- name: iss_cli.sh data processing example
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ping

docs/source/index.rst Outdated Show resolved Hide resolved

::

$ starfish validate experiment tmp/experiment.json
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is plausible that we want to retain the example about validating an existing experiment.

from starfish.core.image.Filter.reduce import Reduce


methods: Mapping[str, Type] = {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ping

Copy link
Collaborator

@dganguli dganguli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this looks really nice ....

@shanaxel42 shanaxel42 merged commit a23ec9f into master Jul 17, 2019
@ttung
Copy link
Collaborator

ttung commented Jul 18, 2019

This broke the docker test.
https://travis-ci.com/spacetx/starfish/jobs/217075503

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants